MembersSecurityApiObject
The details of the security settings for the hierarchy's member elements.
API Section: Objects
Type: Object
Properties
Name |
Description |
Required |
Type |
Format |
---|---|---|---|---|
enableMode |
Set to true for 'Enabled' (included) mode. Set to false for 'Disabled' (excluded) mode. |
Y |
boolean |
|
modelId |
The model's ID |
Y |
string |
|
roleId |
The role id that the settings apply to |
Y |
string |
|
members |
A listing of the unique names of members that need to be secured. Use this or set a script. Not both |
- |
string [ ] |
|
script |
The PQL script to be used to evaluate the member listing that needs to be secured. Use this or a member listing. Not both. |
- |
string |
|
visualTotals |
Enable or disable visual totals. Relevant in parent-child hierarchies security only. |
- |
boolean |
|
hierarchyUniqueName |
The unique name of the hierarchy that contain the members |
Y |
string |
*Required elements are only used for API parameters
Notes
Select only members or script, not both.